Skip to content

docs: add WSL2 and native Linux setup guide to quick-start#2152

Open
nuthalapativarun wants to merge 1 commit into
TEN-framework:mainfrom
nuthalapativarun:docs/wsl-linux-setup-511
Open

docs: add WSL2 and native Linux setup guide to quick-start#2152
nuthalapativarun wants to merge 1 commit into
TEN-framework:mainfrom
nuthalapativarun:docs/wsl-linux-setup-511

Conversation

@nuthalapativarun
Copy link
Copy Markdown

Summary

  • Add a "Running Natively on Linux or WSL2 (Without Docker)" section to docs/getting-started/quick-start.md
  • Covers the full native setup path: WSL2 enablement, C compiler prerequisites, tman installation, build/run workflow
  • WSL2-specific guidance: port forwarding from Windows host, audio device access (WSLg, PulseAudio forwarding, external routing), file system performance tip (keep project inside WSL2 fs)
  • Troubleshooting subsection for the three most common native Linux/WSL2 errors: tman: command not found, missing libpython3.10, and CGO compiler errors

Test plan

  • Verified all commands match the actual tman CLI and Linux toolchain
  • task format — clean (documentation only)
  • Markdown renders correctly (no broken headings or code blocks)

Related Issues

Fixes #511

Add a dedicated section covering non-Docker native setup for Linux and
WSL2: prerequisites, tman installation, build/run workflow, WSL2 port
forwarding, audio device access options (WSLg / PulseAudio), file
system performance tips, and common troubleshooting steps. Addresses TEN-framework#511.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Provide WSL/Linux-specific documentation for non-Docker setups

1 participant